﻿<HTML>
    <HEAD>
        <TITLE>How to upgrade projects</TITLE>
    </HEAD>
    <BODY>
        <h3>How to upgrade projects to current version of SPSF</h3>
        
        After installing a new version of SPSF it is recommended to update the Visual Studio projects which have been created with an earlier version of SPSF. 
        <br /><br />
        The reason is that sometimes a new SPSF version resolves bugs in <a href="SPSF_OVERVIEW_700_SystemFiles.html">SPSF system files</a> which are located in such a Visual Studio project. 
        Typically these are the following files:
        <br /><br />
        <b>Files responsible for a correct build and packaging of the project</b>
        <ul>
            <li>[SolutionDirectory]\SharePointTargets.targets</li>
            <li>[SolutionDirectory]\GenerateManifest.tt</li>
        </ul>

        <b>Files used during the deployment of WSP solutions</b>
        <ul>
            <li>[SolutionDirectory]\ApplicationDeployment\Deployment.msbuild</li>
            <li>[SolutionDirectory]\ApplicationDeployment\MSBuild\SPALM.MSBuildTasks.dll</li>
            <li>[SolutionDirectory]\ApplicationDeployment\DeploymentFiles\StartDeploy.bat</li>
            <li>[SolutionDirectory]\ApplicationDeployment\DeploymentFiles\StartRedeploy.bat</li>
            <li>[SolutionDirectory]\ApplicationDeployment\DeploymentFiles\StartUndeploy.bat</li>
            <li>[SolutionDirectory]\ApplicationDeployment\DeploymentFiles\StartUpgrade.bat</li>
        </ul>

        <b>Settings files for code analysis tools</b>
        <ul>
            <li>[SolutionDirectory]\Settings.ShareCop</li>
            <li>[SolutionDirectory]\Settings.ShareCop</li>
            <li>[SolutionDirectory]\Settings.StyleCop</li>
            <li>[SolutionDirectory]\Settings.FxCop</li>
            <li>[SolutionDirectory]\FxCop.targets</li>
        </ul>       
        <br />
        To upgrade the VS solution run the following steps:
        
        <h4>1. Make a backup copy of your VS solution.</h4>
        This is recommended to avoid breaking changes in your solution. If you are using source control you could skip this step.
        
        <h4>2. Start the migration</h4>
        Execute the recipe "SPSF Helpers -> Migrate solution to current SPSF version".
        <br /><br />
        <img src="./_img/UpgradeSolution.jpg" />
        <br /><br />
		Follow the instructions of the wizard.
        <br /><br />
        <img src="./_img/UpgradeSolutionWizard.jpg" />
        <br /><br />        
        <h4>3. Check results</h4>
        After completion all made changes and replaced files are listed in the output window.
        <br /><br />
        <img src="./_img/UpgradeSolutionOutput.jpg" />
        <br /><br />
        Compilation of your projects should produce the same results.        
    </BODY>
</HTML>